<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Open SCA: frameworks/libCF_StdPorts/include/CyclicBufferController.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.onetek.net"><img alt="Logo" src="openscaLogo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Open SCA
   &#160;<span id="projectnumber">Version 0.6.0</span>
   </div>
   <div id="projectbrief">Open SCA</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_cyclic_buffer_controller_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">CyclicBufferController.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_cyclic_buffer_controller_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//  CyclicBufferController.h</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//  Implementation of the Class CyclicBufferController</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//  Created on:      11-7��-2018 14:33:52</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//  Original author: JHX</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#if !defined(EA_79624BC7_BB4C_4e04_BA35_C7BF6F1EC6C7__INCLUDED_)</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define EA_79624BC7_BB4C_4e04_BA35_C7BF6F1EC6C7__INCLUDED_</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html">   20</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_cyclic_buffer_controller.html">CyclicBufferController</a></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;        <a class="code" href="class_cyclic_buffer_controller.html#a2db3ad4287240ffc52c0536c2589b9d1">CyclicBufferController</a>();</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;        <span class="keyword">virtual</span> <a class="code" href="class_cyclic_buffer_controller.html#acd7665ef52411a62d47cdde4639052b1">~CyclicBufferController</a>();</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;        <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_cyclic_buffer_controller.html#a419f448d18c442430f798e0408e3894b">getWritableSize</a>();</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="class_cyclic_buffer_controller.html#a7e151b044dff0a4f4cedc0858c6fee2e">initializeDataBuf</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufSize);</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;        <span class="keywordtype">char</span>* <a class="code" href="class_cyclic_buffer_controller.html#a6008ed913714ccd961bd8206d152cae2">readData</a>();</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_cyclic_buffer_controller.html#a15df81f47300dc02f6316b48d5fb9f14">releaseBuf</a>();</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="class_cyclic_buffer_controller.html#add639f0a5fe5c958ae8b08b5611b1c4c">writeData</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* writedData, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dataSize);</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html#ab674beb0bdec4270bf9a246e82d0ee11">   37</a></span>&#160;        <span class="keywordtype">char</span> <a class="code" href="class_cyclic_buffer_controller.html#ab674beb0bdec4270bf9a246e82d0ee11">m_dataBuf</a>[80960];</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html#a79cbb344fe0a76309520376cc382d509">   41</a></span>&#160;        <span class="keywordtype">char</span>* <a class="code" href="class_cyclic_buffer_controller.html#a79cbb344fe0a76309520376cc382d509">m_endPtr</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html#ad4f0789743dbcc35d67df9d8622e4f2a">   45</a></span>&#160;        <span class="keywordtype">char</span>* <a class="code" href="class_cyclic_buffer_controller.html#ad4f0789743dbcc35d67df9d8622e4f2a">m_readPtr</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html#a9de1a35839af25576bfd5f3088242bff">   49</a></span>&#160;        <span class="keywordtype">char</span>* <a class="code" href="class_cyclic_buffer_controller.html#a9de1a35839af25576bfd5f3088242bff">m_startPtr</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html#afa9a49f42ffeed0a49c75888c6269fa7">   53</a></span>&#160;        <span class="keywordtype">char</span>* <a class="code" href="class_cyclic_buffer_controller.html#afa9a49f42ffeed0a49c75888c6269fa7">m_writePtr</a>;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html#a28586ac01f5bd99ecb8bdc20eb0a1760">   57</a></span>&#160;        <span class="keywordtype">char</span> <a class="code" href="class_cyclic_buffer_controller.html#a28586ac01f5bd99ecb8bdc20eb0a1760">m_readBuf</a>[20000];</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;        </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="class_cyclic_buffer_controller.html#acd80c8d3d61f215418010b5bedb871d3">   62</a></span>&#160;        <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_cyclic_buffer_controller.html#acd80c8d3d61f215418010b5bedb871d3">m_cycBufSize</a>;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;};</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="preprocessor">#endif // !defined(EA_79624BC7_BB4C_4e04_BA35_C7BF6F1EC6C7__INCLUDED_)</span></div><div class="ttc" id="class_cyclic_buffer_controller_html_ab674beb0bdec4270bf9a246e82d0ee11"><div class="ttname"><a href="class_cyclic_buffer_controller.html#ab674beb0bdec4270bf9a246e82d0ee11">CyclicBufferController::m_dataBuf</a></div><div class="ttdeci">char m_dataBuf[80960]</div><div class="ttdoc">data buffer to store data read from bus </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00037">CyclicBufferController.h:37</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a28586ac01f5bd99ecb8bdc20eb0a1760"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a28586ac01f5bd99ecb8bdc20eb0a1760">CyclicBufferController::m_readBuf</a></div><div class="ttdeci">char m_readBuf[20000]</div><div class="ttdoc">buffer used to store data read </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00057">CyclicBufferController.h:57</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_ad4f0789743dbcc35d67df9d8622e4f2a"><div class="ttname"><a href="class_cyclic_buffer_controller.html#ad4f0789743dbcc35d67df9d8622e4f2a">CyclicBufferController::m_readPtr</a></div><div class="ttdeci">char * m_readPtr</div><div class="ttdoc">pointer used to read data form buffer </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00045">CyclicBufferController.h:45</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a6008ed913714ccd961bd8206d152cae2"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a6008ed913714ccd961bd8206d152cae2">CyclicBufferController::readData</a></div><div class="ttdeci">char * readData()</div><div class="ttdoc">Read data form buffer, a packet one time. </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8cpp_source.html#l00141">CyclicBufferController.cpp:141</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html"><div class="ttname"><a href="class_cyclic_buffer_controller.html">CyclicBufferController</a></div><div class="ttdoc">The class managers a buffer which used to store data form bus and privide data to waveform...</div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00020">CyclicBufferController.h:20</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a79cbb344fe0a76309520376cc382d509"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a79cbb344fe0a76309520376cc382d509">CyclicBufferController::m_endPtr</a></div><div class="ttdeci">char * m_endPtr</div><div class="ttdoc">end pointer of data buffer </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00041">CyclicBufferController.h:41</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_add639f0a5fe5c958ae8b08b5611b1c4c"><div class="ttname"><a href="class_cyclic_buffer_controller.html#add639f0a5fe5c958ae8b08b5611b1c4c">CyclicBufferController::writeData</a></div><div class="ttdeci">bool writeData(const char *writedData, unsigned int dataSize)</div><div class="ttdoc">Write data to data buffer. </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8cpp_source.html#l00089">CyclicBufferController.cpp:89</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_acd80c8d3d61f215418010b5bedb871d3"><div class="ttname"><a href="class_cyclic_buffer_controller.html#acd80c8d3d61f215418010b5bedb871d3">CyclicBufferController::m_cycBufSize</a></div><div class="ttdeci">unsigned int m_cycBufSize</div><div class="ttdoc">size of cyclic buffer </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00062">CyclicBufferController.h:62</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a15df81f47300dc02f6316b48d5fb9f14"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a15df81f47300dc02f6316b48d5fb9f14">CyclicBufferController::releaseBuf</a></div><div class="ttdeci">void releaseBuf()</div><div class="ttdoc">Free the buffer memory. </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8cpp_source.html#l00186">CyclicBufferController.cpp:186</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a2db3ad4287240ffc52c0536c2589b9d1"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a2db3ad4287240ffc52c0536c2589b9d1">CyclicBufferController::CyclicBufferController</a></div><div class="ttdeci">CyclicBufferController()</div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8cpp_source.html#l00016">CyclicBufferController.cpp:16</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a9de1a35839af25576bfd5f3088242bff"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a9de1a35839af25576bfd5f3088242bff">CyclicBufferController::m_startPtr</a></div><div class="ttdeci">char * m_startPtr</div><div class="ttdoc">statr pointer of data buffer </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00049">CyclicBufferController.h:49</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a419f448d18c442430f798e0408e3894b"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a419f448d18c442430f798e0408e3894b">CyclicBufferController::getWritableSize</a></div><div class="ttdeci">unsigned int getWritableSize()</div><div class="ttdoc">Get size of remaining buffer which can be written data. </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8cpp_source.html#l00038">CyclicBufferController.cpp:38</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_acd7665ef52411a62d47cdde4639052b1"><div class="ttname"><a href="class_cyclic_buffer_controller.html#acd7665ef52411a62d47cdde4639052b1">CyclicBufferController::~CyclicBufferController</a></div><div class="ttdeci">virtual ~CyclicBufferController()</div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8cpp_source.html#l00027">CyclicBufferController.cpp:27</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_afa9a49f42ffeed0a49c75888c6269fa7"><div class="ttname"><a href="class_cyclic_buffer_controller.html#afa9a49f42ffeed0a49c75888c6269fa7">CyclicBufferController::m_writePtr</a></div><div class="ttdeci">char * m_writePtr</div><div class="ttdoc">pointer use to write data to buffer </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8h_source.html#l00053">CyclicBufferController.h:53</a></div></div>
<div class="ttc" id="class_cyclic_buffer_controller_html_a7e151b044dff0a4f4cedc0858c6fee2e"><div class="ttname"><a href="class_cyclic_buffer_controller.html#a7e151b044dff0a4f4cedc0858c6fee2e">CyclicBufferController::initializeDataBuf</a></div><div class="ttdeci">bool initializeDataBuf(unsigned int bufSize)</div><div class="ttdoc">Initialize data buffer, allocate memory which size is determined by input parameter. </div><div class="ttdef"><b>Definition:</b> <a href="_cyclic_buffer_controller_8cpp_source.html#l00054">CyclicBufferController.cpp:54</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_27e7b6da28153e106312658788f622d3.html">frameworks</a></li><li class="navelem"><a class="el" href="dir_415fd844ad1371cc0541b88918b9f3f6.html">libCF_StdPorts</a></li><li class="navelem"><a class="el" href="dir_1930bbf1458d085ae133456611e5443a.html">include</a></li><li class="navelem"><a class="el" href="_cyclic_buffer_controller_8h.html">CyclicBufferController.h</a></li>
    <li class="footer">Generated on Fri Jul 12 2019 14:31:52 for
    <a href="http://www.onetek.net">
    <img class="footer" src="openscaLogo.png" height="31" alt="openSCA"/></a>
    </li>
  </ul>
</div>
</body>
</html>
